このページは、以下に示す作業/手順トピックテンプレートに基づいています。他に同様のトピックを作成する場合は、このテンプレートを使用します。
顧客が住宅ローンの申請書を提出したら、次の手順に従って申請を許可し、処理を開始します。
運転免許証で顧客の名前と住所を確認します。
必要なすべてのフィールドが記入されていることを確認します。
...
(2006 年 7 月 31 日改訂)
作業トピックは、ユーザが特定の結果を得るために実行する指示であり、一連の番号付きの手順がよく使用されます。作業トピックには、手順の実行時期、手順を実行するユーザ、手順を実行することで発生する問題、必要なすべての前提条件、作業の実行にかかる時間、必要なツールを含めることができます。多くのプロジェクトでは、作成するトピックの大部分が作業トピックになります。一般的に作業トピックでは、特定の手順に焦点を絞ると共に、他の種類のトピック(情報トピック、参照トピックなど)へのリンクを含めることで、より充実したコンテキストや詳細情報を提供します。
作業の実行手順を列挙する前に、ユーザがその作業を実行することの利点や必要性を説明する文を記述します。これにより、ユーザは一定のコンテキストを把握でき、作業がユーザの状況に応じたものであるかどうかを確認できます。
手順に見出しを付け、見出し 4 や 5 などの下位レベルの見出しスタイルを割り当てます。例えば、次のように記述します。
手順 1
手順 2
手順 3
手順 4
手順 5
リンクのリストを記述したり、関連トピックボタンを追加したりして、他のトピックへの適切なリンクを追加します。
関連項目:
(2006 年 7 月 31 日改訂)